sqlx4k-sqlite/io.github.smyrgeorge.sqlx4k.sqlite/[jvm]SQLite

SQLite

class SQLite(url: String, options: ConnectionPool.Options = ConnectionPool.Options(), val encoders: ValueEncoderRegistry = ValueEncoderRegistry()) : ISQLite(source)

SQLite class provides mechanisms to interact with a SQLite database on the JVM platform. It implements Driver, Driver.Pool, and Driver.Transactional interfaces, offering functionalities such as connection pooling, executing queries, fetching data, and handling transactions.

The URL format for SQLite can be one of the following:

jdbc:sqlite::memory: - Creates an in-memory database
jdbc:sqlite:database.db - Creates/opens a database file
jdbc:sqlite:/path/to/database.db - Uses absolute path

If the URL does not start with "jdbc:sqlite:", it will be automatically prefixed.

Parameters

url

The URL of the SQLite database to connect to.

options

Optional pool configuration, defaulting to ConnectionPool.Options.

encoders

Optional registry of value encoders to use for encoding query parameters.

Constructors

SQLite

constructor(url: String, options: ConnectionPool.Options = ConnectionPool.Options(), encoders: ValueEncoderRegistry = ValueEncoderRegistry())

Types

Companion

object Companion

JdbcConnection

class JdbcConnection(connection: Connection, val encoders: ValueEncoderRegistry) : Connection

JdbcTransaction

class JdbcTransaction(connection: Connection, closeConnectionAfterTx: Boolean, val encoders: ValueEncoderRegistry) : Transaction

Properties

encoders

open override val encoders: ValueEncoderRegistry

Functions

acquire

open suspend override fun acquire(): Result<Connection>

begin

open suspend override fun begin(): Result<Transaction>

open suspend override fun close(): Result<Unit>

execute

open suspend fun execute(statement: Statement): Result<Long>

open suspend override fun execute(sql: String): Result<Long>

fetchAll

open suspend fun fetchAll(statement: Statement): Result<ResultSet>

open suspend fun <T> fetchAll(statement: Statement, rowMapper: RowMapper<T>): Result<List<T>>

open suspend fun <T> fetchAll(sql: String, rowMapper: RowMapper<T>): Result<List<T>>

open suspend override fun fetchAll(sql: String): Result<ResultSet>

migrate

open suspend override fun migrate(supplier: () -> List<MigrationFile>, table: String, schema: String?, createSchema: Boolean, afterStatementExecution: suspend (Statement, Duration) -> Unit, afterFileMigration: suspend (Migration, Duration) -> Unit): Result<Migrator.Results>

open suspend override fun migrate(path: String, table: String, schema: String?, createSchema: Boolean, afterStatementExecution: suspend (Statement, Duration) -> Unit, afterFileMigration: suspend (Migration, Duration) -> Unit): Result<Migrator.Results>

open suspend override fun migrate(files: List<MigrationFile>, table: String, schema: String?, createSchema: Boolean, afterStatementExecution: suspend (Statement, Duration) -> Unit, afterFileMigration: suspend (Migration, Duration) -> Unit): Result<Migrator.Results>

poolIdleSize

open override fun poolIdleSize(): Int

poolSize

open override fun poolSize(): Int

transaction

open suspend fun <T> transaction(f: suspend Transaction.() -> T): T

transactionCatching

open suspend fun <T> transactionCatching(f: suspend Transaction.() -> T): Result<T>